RequestFocusSet

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODArbitrator

RequestFocusSet
The RequestFocusSet method requests that the ownership of each focus in the specified focus set be assigned to the specified frame.
ODBoolean RequestFocusSet (in ODFocusSet focusSet, 
                           in ODFrame requestingFrame);
focusSet
A reference to a focus set being requested.
requestingFrame
A reference to a frame requesting the focus.
return value
kODTrue if the frame obtained the focus set, otherwise kODFalse.

DISCUSSION
For the requested ownership to be granted, all existing owners of exclusive foci within the specified set must be willing to relinquish these same foci.
If all of the foci, exclusive and nonexclusive, are attainable, then the request is granted. However, if even one focus is unattainable, ownership of the focus set is not granted.
If the request is granted, the new ownership relationships are stored in the relevant focus modules. If the request fails, the existing ownership relationships remain intact.
If the request is granted, the arbitrator contains a reference to the frame. Parts should relinquish the focus in the DisplayFrameClosed or DisplayFrameRemoved methods.

EXCEPTIONS

kODErrFocusNotRegistered
One of the specified foci is not registered.

SEE ALSO
The ODArbitrator::RequestFocus method (page 53).
Listing 2-36 on page 94 in OpenDoc Cookbook.
Listing 2-38 on page 95 in OpenDoc Cookbook.
"Requesting Foci" on page 208 in OpenDoc Programmer's Guide.
"On Frame Activation" on page 211 in OpenDoc Programmer's Guide.